home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / time / dclock16.lha / DClock16 / DClock.doc < prev    next >
Encoding:
Text File  |  1995-03-05  |  10.2 KB  |  305 lines
  1.  
  2.     DClock V1.6 - The ultimate, menu driven Workbench-Clock
  3.     =======================================================
  4.  
  5.  
  6.     Introduction
  7.     ------------
  8.  
  9.     DClock is a digital clock program for the Amiga.
  10.     Features include:
  11.  
  12.     - DClock has it's own small window which can be placed
  13.       anywhere on the Workbench or any other public screen.
  14.  
  15.     - DClock  comes with a completely  menu-driven GUI. No
  16.       commandline options are necessary (but they are
  17.       nevertheless possible. See Tooltypes).
  18.  
  19.     - Timer and alarm clock function with the ability to
  20.       run user-defined Shell commands (including ARexx-
  21.       scripts if you use the RX command, and Shell-scripts
  22.       with the Execute command).
  23.  
  24.     - Date function
  25.  
  26.     - Fore- and  background colors of the window are user-
  27.       defineable.
  28.  
  29.     - All settings  can be saved and will automatically be
  30.       loaded upon startup. This  includes the  position of
  31.       the DClock window, the  colors, and  the settings of
  32.       the alarm clock.
  33.  
  34.     - Iconify function
  35.  
  36.  
  37.     Requirements and Installation
  38.     -----------------------------
  39.  
  40.     DClock makes use of the  reqtools.library, which is not part
  41.     of this distribution. It is  available  on Aminet or  on the
  42.     Amiga software library (fish) disks. Thanks to Nico Francois
  43.     for his great product.
  44.     You need Kickstart 2.04+ to be able to run DClock. If DClock
  45.     immediately  returns after startup, check  whether you  have
  46.  
  47.            Kickstart V37+
  48.            reqtools.library V38+
  49.            a public screen called 'Workbench'
  50.            enough free memory
  51.  
  52.  
  53.     Installation is very simple: Simply drag  the DClock icon to
  54.     the WBStartup drawer of your system partition/disk or to any
  55.     other drawer, if you don't want DClock to be started automa-
  56.     tically after booting.
  57.  
  58.  
  59.     DClock Menus
  60.     ------------
  61.  
  62.     While the DClock window is active, you can select the follo-
  63.     wing menu items:
  64.  
  65.     DClock menu:
  66.  
  67.        Seconds (toggle) : Display seconds on/off
  68.  
  69.        24H (toggle)     : Toggle between 24 hour mode or 12 hour
  70.                           AM/PM mode, and, if Date is on,
  71.                           between DD.MM.YYYY and MM.DD.YYYY
  72.  
  73.        Date (toggle)    : Turn date on/off
  74.  
  75.        dd-mm-yyyy       : Select date format: DD-MM-YYYY
  76.        (toggle)           or MM-DD-YYYY
  77.  
  78.        Alarm on (toggle): Turn alarm function on/off
  79.  
  80.        Timer on (toggle): Turn timer function on/off
  81.  
  82.        Set alarm clock  : Set the alarm time
  83.  
  84.        Set timer        : Set the timer
  85.  
  86.        Alarm command    : Enter a Shell-command which will be
  87.                           executed when the alarm went off.
  88.                           RUN your command if if it takes longer
  89.                           and you don't want to block out the GUI.
  90.  
  91.        Timer command    : dito for the timer.
  92.  
  93.        Save Preferences : Save all the settings to
  94.                           ENVARC:DClock.prefs
  95.  
  96.        About...         : Information about me
  97.  
  98.        Quit             : Call the Terminator
  99.  
  100.     Window menu:
  101.  
  102.        Foreground Color : Set the foreground (text) color
  103.  
  104.        Background Color : Set the background color (who would
  105.                           have guessed...)
  106.  
  107.        Dragbar (toggle) : Turn the window dragbar and title on
  108.                           and off. The state of the checkmark
  109.                           will be saved in the preferences file.
  110.  
  111.        Activate (toggle): Activate DClock window after startup/
  112.                           reopen.
  113.  
  114.        Iconify          : Iconify the DClock window and unlock the
  115.                           public screen DClock is running on. This
  116.                           allows you to change the screenmode of
  117.                           your Workbench screen without quitting
  118.                           DClock.
  119.  
  120.  
  121.     When you select `Save Preferences'  from  the  Project menu, the
  122.     state  of the alarm  clock  will be saved, too. The  alarm  will
  123.     then be automatically turned on after startup (if it was on when
  124.     you saved  the prefs, off course). I e.g. set the  alarm to 1.00
  125.     AM, switched  it on and  selected `Save preferences'. I  now get
  126.     reminded every day that it's time to go to bed without having to
  127.     set the alarm again and again.
  128.  
  129.  
  130.     Tooltypes
  131.     ---------
  132.  
  133.     Well, as for now there are only two of them:
  134.  
  135.     DONOTWAIT
  136.                You need this if you  put DClock into the WBStartup
  137.                drawer so that Workbench doesn't wait for DClock to
  138.                return
  139.  
  140.     PUBSCREEN=name
  141.                The name of an open  public screen  you want DClock
  142.                to pop up  on. If the specified screen  is not open
  143.                or if it can't be locked for any reason, the  Work-
  144.                bench screen is used instead.
  145.  
  146.     You can enter this as argument on the commandline of your shell:
  147.  
  148.        DClock PUBSCREEN=Gaga_Screen
  149.  
  150.  
  151.  
  152.     Legal section
  153.     -------------
  154.  
  155.     DClock V1.6 (c) 1994/1995 by Karl Lukas.
  156.  
  157.     This program is Freely Distributable, as  opposed to Public
  158.     Domain.  Permission  is given  to  freely  distribute  this
  159.     program  provided  no  fee  is charged, and  this  documen-
  160.     tation  file  is included with the archive. All  rights re-
  161.     served.
  162.     From version 1.6 on  the source code is part of the distri-
  163.     bution. You may change DClock according to your needs with-
  164.     out permission. If you plan  to release your work publicly,
  165.     however, you have to respect the following points:
  166.  
  167.     o Give it another name
  168.  
  169.     o Your documentation must have the following statement in
  170.       the beginning:
  171.       "... is based on DClockxx, (c) 1995 by Karl Lukas"
  172.  
  173.     o You must provide a history file which documents all the
  174.       changings you made to the original code.
  175.  
  176.     o Your must make your code available to me upon request.
  177.  
  178.     o Your About-requester must mention my name (something
  179.       like: ... written by Karl Lukas and ...).
  180.  
  181.     o You must not claim any copyright on any parts of my code.
  182.  
  183.     o You must release your program as FREEWARE.
  184.  
  185.  
  186.  
  187.     Info about the author
  188.     ---------------------
  189.  
  190.     Send bug reports, compliments and such to
  191.  
  192.        kalle@gis.geogr.unizh.ch
  193.  
  194.     (This account will probably close down soon)
  195.  
  196.     Send postcards, money and other gifts to
  197.  
  198.        Karl Lukas
  199.        Hinterzweienstr. 91
  200.        CH-4132 Muttenz
  201.        Switzerland
  202.  
  203.     Send threatening letters, letter bombs a.s.o. to
  204.  
  205.        NIL:
  206.  
  207.  
  208.  
  209.     History
  210.     -------
  211.  
  212.     V1.0 Apr 1994 o Initial release
  213.  
  214.     V1.1 Jun 1994 o DClock now runs three independent tasks:
  215.                     - User interface  (DClock)
  216.                     - Updating of the DClock window, timer etc.
  217.                       (DClockTask)
  218.                     - display information when alarm went off or
  219.                       timer is finished (DClockInfo).
  220.                     Advantage: Clock and timer won't be stopped tem-
  221.                     porarily while a window/requester is open. You
  222.                     can get informed now when the timer/alarm went
  223.                     off while a window/requester is open.
  224.  
  225.                   o Bug: The alarm and timer symbols were drawn with
  226.                     incorrect offsets, so that the display got mes-
  227.                     sed if big screen fonts were used.
  228.  
  229.                   o The settings are now stored in ENVARC:DClock.prefs
  230.                     You can copy your old DClock.prefs file from S: to
  231.                     ENVARC: if you want to use your old settings.
  232.  
  233.     V1.2 Nov 1994 o You can now enter a Shell command, which will be
  234.                     executed when the alarm or the timer went off. The
  235.                     command can be saved to the preferences file. If you
  236.                     don't want to execute a command, just enter an empty
  237.                     string.
  238.  
  239.                   o The current time is now displayed with two digits
  240.                     in the alarm/timer requester (i.e. 18:08:12 instead
  241.                     of 18:8:12). Hey, there is an ANSI function for
  242.                     this. Why didn't anybody tell me?  ;)
  243.  
  244.                   o You can now turn the titlebar and dragbar off with
  245.                     the menu option "Dragbar". Off course you cannot move
  246.                     the window anymore when the dragbar is turned off.
  247.                     You can save the state of the "Dragbar" menu item to
  248.                     the preferences. THIS ONLY TAKES EFFECT WHEN YOU QUIT
  249.                     AND START DCLOCK AGAIN.
  250.  
  251.     V1.3 Nov 1994 o OK, the dragbar switching was not very elegant. Now
  252.                     you can turn the dragbar on and off without leaving
  253.                     the program.
  254.  
  255.                   o Got rid of the `Snapshot position' menu item. Now
  256.                     `Save preferences' saves the current position, too.
  257.  
  258.                   o I rearranged the menus to a somewhat more logical
  259.                     order.
  260.  
  261.                   o `Alarm command' and `Timer command' now use the
  262.                      SystemTagList() function. A console window is opened
  263.                      as stdin/stdout for the executed program, so you can
  264.                      actually _see_ it's output if you started DClock from
  265.                      the Workbench. Nice, isn't it?
  266.  
  267.     V1.4 Dec 1994 o 12 hour AM/PM mode added.
  268.  
  269.     V1.5 Dec 1994 o (I should actually be preparing for my exams... :)
  270.  
  271.                   o Little bug fixed: You could deadlock DClock by
  272.                     immediately quitting it after startup (this was
  273.                     only theoretical as you had no chance to immediately
  274.                     quit DClock because the window was not activated).
  275.  
  276.                   o OS3.0+ users now get white menus.
  277.  
  278.                   o Date function added. If the 24H mode is active,
  279.                     the date is displayed as DD.MM.YYYY. Otherwise day and
  280.                     month are swapped (i.e. MM.DD.YYYY). I hope this suits
  281.                     your needs.
  282.  
  283.                   o New menu item `Activate' added.
  284.  
  285.                   o New menu shortcuts added
  286.  
  287.     V1.6 Feb 1995 o Pubscreens are now supported
  288.  
  289.                   o New menu item: dd-mm-yyyy
  290.                     You can now toggle the date and time formats
  291.                     independently.
  292.  
  293.                   o Iconify function added
  294.  
  295.                   o The source code is now part of the distribution
  296.                     SEE `LEGALITIES' BEFORE YOU USE IT!!!
  297.  
  298.  
  299.     DClock - The t-shirt
  300.     --------------------
  301.  
  302.     Just kidding ;)
  303.  
  304.  
  305.